Class: com.microstrategy.web.app.taglibs.StringTag
Usage:
This custom tag allows users to displayed localized strings from Microstrategy's MessagesBundle, based on the ID that is indicated on the key attribute value. Note: The "descriptor" tag accomplishes the same behavior and its syntax describes the purpose of the tag better.<SPAN CLASS=highlighted> <web:descriptor key="mstrWeb.792" desc="XML API version:" /> </SPAN>
Name | Required? | Description |
attribute | false | Indicates the HTML attribute to create which will have as value the string found on the Messages collection corresponding to the given key. Usage: An HTML tag defined as this: <IMG <web:resource attribute="SRC" name="desktop_HistoryList.gif" WIDTH="60" HEIGHT="60" <web:descriptor attribute="ALT" key="mstrWeb.4" desc="History List" /> BORDER="0" />Will generate this final HTML output:
<IMG SRC="../images/desktop_HistoryList.gif" WIDTH="60" HEIGHT="60" ALT="History List" BORDER="0" />
|
beanType | false | Indicates the type of bean that will be used as base for getting the descriptor to display based on the type attribute defined for the tag. Usage: If the type attribute of the tag is defined as status, then the key to use for retrieving the descriptor to display will be defined by a method that maps the bean and its current status and generates a key for the message to show. The possible values for this attribute include: getReportStatusDescriptorKey(int) method defined on the AbstractReportTransform class for mapping
the report bean status against the key of the descriptor that should be displayed. |
desc | false | Indicates an alternative description to use if the key is not specified. |
jsEncode | false | Indicates if the output to render should be encoded for Javascript or not. Usage: The encoding that Javascript requires is different from the one done for HTML; for example, quotes need to be paid special attention. The default value if this attribute is not specified is False . |
key | false | Indicates the key of the localized string that will be displayed, according to the user's settings. |
replaceValue | false | Indicates if the ## string found in the localized message should be replaced by another given string value. Usage: If this attribute is specified, the original string that was found given the key will have the ## occurences
(if any found) replaced by the text exactly as specified on this attribute. |
type | false | Indicates the type of descriptor that will be displayed by this tag. Usage: Currently, this attribute should be used together with beanType. The possible values for this attribute include: |
ucase | false | Indicates if the localized string to display should be changed to all upper case font. |